Customizing Imperat

Imperat provides extensive customization options through its builder pattern. This guide covers all available configuration methods and their default values.

Overview

When creating an Imperat instance, you can configure various components using the builder pattern:

BukkitImperat imperat = BukkitImperat.builder(plugin)
    .parameterType(Arena.class, new ArenaParameterType())
    .helpProvider(new CustomHelpProvider())
    .build();

Configuration Options

Command Processing

commandPrefix(String cmdPrefix)

Sets the command prefix for the command processing chain.

Default: "/"

Minecraft Platform Limitation

This option does not work with Minecraft-related platforms (Bukkit, Spigot, Paper, etc.). The prefix will be ignored on these platforms.

BukkitImperat.builder(plugin)
    .commandPrefix("!")  // This will be ignored on Minecraft platforms
    .build();

strictCommandTree(boolean strict)

Sets whether the command tree should be strict. When strict, commands must match exactly.

Default: false

BukkitImperat.builder(plugin)
    .strictCommandTree(true)
    .build();

Permission System

permissionChecker(PermissionChecker<S> permissionChecker)

Sets a custom permission interface for handling permission checks. Allows you to define how permissions are checked.

Default: (source, permission) -> true (allows all permissions)

BukkitImperat.builder(plugin)
    .permissionResolver(new CustomPermissionResolver())
    .build();

نکته

For more details on permission handling, see Error-Handler.

autoPermissionAssignMode(boolean modeToggle)

Enables Auto Permission Assign (APA) mode, which automatically generates and assigns permissions to every command parameter, subcommand, and root command.

Default: false

What it does: When enabled, Imperat automatically creates permission nodes for your entire command structure without you having to manually set permissions for each parameter.

Example:

BukkitImperat.builder(plugin)
    .autoPermissionAssignMode(true)  // Enable automatic permission assignment
    .build();

Generated permissions might look like:

• Command: /admin ban <player> → Permissions: plugin.admin, plugin.admin.ban
• Command: /kit give <kit> [player] → Permissions: plugin.kit, plugin.kit.give

Benefits:

• No manual work: Never forget to set permissions again
• Consistent structure: All commands follow the same permission pattern
• Automatic updates: New commands automatically get appropriate permissions
• Fine-grained control: Each parameter can have its own permission check

Prerequisites

APA mode must be enabled before configuring permissionLoader() or permissionAssigner().

permissionLoader(PermissionLoader<S> permissionLoader)

Sets how permissions are loaded and determined for command parameters when APA mode is active.

Prerequisites: APA mode must be enabled first

What it does: The permission loader decides what permissions should be assigned to each command element based on your custom logic.

Example:

BukkitImperat.builder(plugin)
    .autoPermissionAssignMode(true)  // Must enable APA first
    .permissionLoader(new CustomPermissionLoader())
    .build();

public class CustomPermissionLoader implements PermissionLoader<BukkitSource> {
    @Override
    public String loadPermission(ParameterNode<BukkitSource> node) {
        // Create permission based on command path
        String commandPath = node.getCommandPath();
        return "myplugin." + commandPath.replace(" ", ".");
        
        // Example: "/admin ban player" → "myplugin.admin.ban.player"
    }
}

Common use cases:

• Custom permission patterns: Use your own naming convention
• Dynamic permissions: Generate permissions based on command context
• Plugin-specific prefixes: All permissions start with your plugin name
• Role-based permissions: Different permission levels for different command types

permissionAssigner(NodePermissionAssigner<S> permissionAssigner)

Sets how permissions are applied to command parameter nodes when APA mode is active.

Prerequisites: APA mode must be enabled first

What it does: The permission assigner decides how the permissions (determined by the loader) are actually applied to your command nodes.

Default: Uses NodePermissionAssigner.defaultAssigner()

Example:

BukkitImperat.builder(plugin)
    .autoPermissionAssignMode(true)  // Must enable APA first
    .permissionAssigner(new CustomPermissionAssigner())
    .build();

public class CustomPermissionAssigner implements NodePermissionAssigner<BukkitSource> {
    @Override
    public void assignPermission(ParameterNode<BukkitSource> node, String permission) {
        // Apply permission with custom logic
        if (node.isOptionalParameter()) {
            // Optional parameters get different permission handling
            node.setPermission(permission + ".optional");
        } else {
            // Required parameters get standard permissions
            node.setPermission(permission);
        }
    }
}

Common use cases:

• Different permission strategies: Optional vs required parameters
• Conditional permissions: Apply permissions based on parameter type
• Permission inheritance: Child nodes inherit parent permissions
• Custom validation: Add extra checks before assigning permissions

Complete APA Example

Here's how to set up a complete Auto Permission Assign system:

BukkitImperat imperat = BukkitImperat.builder(plugin)
    // Step 1: Enable APA mode
    .autoPermissionAssignMode(true)
    
    // Step 2: Configure how permissions are loaded
    .permissionLoader(node -> {
        String path = node.getCommandPath().replace(" ", ".");
        return "myplugin.commands." + path;
    })
    
    // Step 3: Configure how permissions are assigned
    .permissionAssigner((node, permission) -> {
        // Add role-based suffixes
        if (node.isSubCommand()) {
            node.setPermission(permission + ".use");
        } else if (node.isOptionalParameter()) {
            node.setPermission(permission + ".optional");
        } else {
            node.setPermission(permission);
        }
    })
    
    .build();

Result for command /admin ban <player> [reason]:

• Root: myplugin.commands.admin.use
• Subcommand: myplugin.commands.admin.ban.use
• Player parameter: myplugin.commands.admin.ban.player
• Reason parameter: myplugin.commands.admin.ban.reason.optional

APA Benefits

• Zero manual permission setup: All commands automatically get permissions
• Consistent permission structure: Follow the same pattern across your plugin
• Dynamic permission generation: New commands automatically get appropriate permissions
• Fine-grained control: Each parameter can have different permission requirements

APA Limitations

• Must enable APA mode before configuring loader/assigner
• Can make permission trees very deep for complex commands
• May generate more permissions than needed for simple commands

Context System

contextFactory(ContextFactory<S> contextFactory)

Sets the context factory for creating contexts used in command execution.

Default: ContextFactory.defaultFactory()

BukkitImperat.builder(plugin)
    .contextFactory(new CustomContextFactory())
    .build();

contextResolver(Type type, ContextResolver<S, T> resolver)

Registers a context resolver for a specific type to provide default values.

BukkitImperat.builder(plugin)
    .contextResolver(Player.class, (source) -> source.as(Player.class))
    .build();

contextResolverFactory(Type type, ContextResolverFactory<S, T> factory)

Registers a context resolver factory for creating resolvers dynamically.

BukkitImperat.builder(plugin)
    .contextResolverFactory(Player.class, new PlayerContextResolverFactory())
    .build();

نکته

For detailed information on context resolvers, see Context Resolver.

Parameter Types

parameterType(Type type, ParameterType<S, T> resolver)

Registers a custom parameter type for parsing command arguments.

BukkitImperat.builder(plugin)
    .parameterType(Arena.class, new ArenaParameterType())
    .parameterType(Kit.class, new KitParameterType())
    .build();

نکته

For comprehensive information on parameter types, see Parameter Types.

Suggestion System

defaultSuggestionResolver(SuggestionResolver<S> resolver)

Sets the default suggestion resolver for providing autocomplete suggestions.

Default: (context, input) -> Collections.emptyList() (no suggestions)

BukkitImperat.builder(plugin)
    .defaultSuggestionResolver(new CustomSuggestionResolver())
    .build();

namedSuggestionResolver(String name, SuggestionResolver<S> resolver)

Registers a named suggestion resolver that can be referenced by name.

BukkitImperat.builder(plugin)
    .namedSuggestionResolver("players", new PlayerSuggestionResolver())
    .build();

نکته

For detailed information on suggestion resolvers, see Suggestion Resolver.

overlapOptionalParameterSuggestions(boolean overlap)

Controls whether consecutive optional parameter suggestions should overlap with each other.

Default: false

BukkitImperat.builder(plugin)
    .overlapOptionalParameterSuggestions(true)
    .build();

Behavior:

• false (default): Only the corresponding suggestions of the corresponding optional parameter, are suggested at a time, preventing overwhelming users with too many optional choices
• true: All suggestions of consecutive optional parameters are suggested simultaneously ONLY IF THEY ARE OF DIFFERENT TYPE, allowing users to see all possible optional arguments they can provide at the current position

What it affects:

• Only optional parameters - required parameters are always suggested regardless of this setting
• Tab completion suggestions

at the same command depth level

یادداشت

This setting only affects optional parameters. Required parameters are always suggested regardless of this configuration.

handleMiddleOptionalArgSkipping(boolean handle)

Controls whether Imperat should handle the skipping of consecutive optional arguments during execution with no respect for the order of optional arguments.

Default: false

BukkitImperat.builder(plugin)
    .handleMiddleOptionalArgSkipping(true)
    .build();

Behavior:

• false (default): Imperat's ParameterValueAssigner respects the order of optional arguments and resolves them in order
• true: Imperat handles skipping of consecutive optional arguments during execution, assigning values based on type compatibility regardless of order

Example:

@Command("test")
public void testCommand(BukkitSource source, @Optional String a, @Optional Integer b) {
    // With handleExecutionMiddleOptionalSkipping = true
    // /test 1 -> a = null, b = 1 (skips 'a', assigns 1 to 'b' because it's Integer type)
    // /test hello 42 -> a = "hello", b = 42
    // /test 42 hello -> a = "hello", b = 42 (reorders based on type)
}

What it affects:

• Optional parameter resolution during command execution
• Type-based assignment of optional arguments regardless of order

defaultAttachmentMode(AttachmentMode attachmentMode)

Sets the default attachment mode for all subcommands that don't explicitly specify an attachment mode.

Default: AttachmentMode.MAIN

BukkitImperat.builder(plugin)
    .defaultAttachmentMode(AttachmentMode.EMPTY)
    .build();

Behavior:

• MAIN (default): Subcommands are attached after the parent's main/required parameters
• DEFAULT: Subcommands are attached after the parent's default parameters
• EMPTY: Subcommands are attached directly to the parent, ignoring all parent parameters

Example:

@Command("admin")
public final class AdminCommand {
    
    @Usage
    public void defaultUsage(BukkitSource source) {
        source.reply("Admin commands: /admin ban <player>, /admin kick <player>");
    }
    
    @SubCommand("ban") // Will use the default attachment mode
    public void banPlayer(BukkitSource source, @Named("player") Player player) {
        // Implementation
    }
}

What it affects:

• Default attachment behavior for all subcommands
• Global fallback when individual subcommands don't specify attachment mode
• Consistent subcommand behavior across your command system

Source Resolution

sourceResolver(Type type, SourceResolver<S, R> sourceResolver)

Registers a source resolver for converting command sources to custom types.

BukkitImperat.builder(plugin)
    .sourceResolver(CustomSource.class, CustomSource::new)
    .build();

نکته

For detailed information on source resolvers, see Source Resolver.

Processing Chain

preProcessor(CommandPreProcessor<S> preProcessor)

Adds a pre-processor to the execution chain (runs before argument resolution).

BukkitImperat.builder(plugin)
    .preProcessor(new CustomPreProcessor())
    .build();

postProcessor(CommandPostProcessor<S> postProcessor)

Adds a post-processor to the execution chain (runs after argument resolution).

BukkitImperat.builder(plugin)
    .postProcessor(new CustomPostProcessor())
    .build();

نکته

For detailed information on processors, see Processors.

preProcessingChain(CommandProcessingChain<S, CommandPreProcessor<S>> chain)

Sets a custom pre-processing chain, replacing the default chain.

Default: Chain with preUsagePermission() and preUsageCooldown()

BukkitImperat.builder(plugin)
    .preProcessingChain(CommandProcessingChain.<S>preProcessors()
        .then(new CustomPreProcessor())
        .build())
    .build();

postProcessingChain(CommandProcessingChain<S, CommandPostProcessor<S>> chain)

Sets a custom post-processing chain, replacing the default chain.

Default: Empty chain

BukkitImperat.builder(plugin)
    .postProcessingChain(CommandProcessingChain.<S>postProcessors()
        .then(new CustomPostProcessor())
        .build())
    .build();

Error Handling

throwableResolver(Class<T> exception, ThrowableResolver<T, S> handler)

Registers a custom exception handler for specific exception types.

BukkitImperat.builder(plugin)
    .throwableResolver(CustomException.class, (imperat, exception, context) -> {
        // Handle the custom exception
        context.source().reply("Custom error: " + exception.getMessage());
    })
    .build();

نکته

For comprehensive information on error handling, see Error-Handler.

Dependency Injection

dependencyResolver(Type type, DependencySupplier resolver)

Registers a dependency resolver for providing instances of specific types.

BukkitImperat.builder(plugin)
    .dependencyResolver(PluginManager.class, () -> plugin.getServer().getPluginManager())
    .build();

نکته

For information on using dependency injection in commands, see Dependency Injection.

Custom Annotations

annotationReplacer(Class<A> annotationType, AnnotationReplacer<A> replacer)

Registers a custom annotation replacer for creating custom annotations.

BukkitImperat.builder(plugin)
    .annotationReplacer(CustomAnnotation.class, new CustomAnnotationReplacer())
    .build();

نکته

For detailed information on creating custom annotations, see Custom Annotations.

Help System

helpProvider(HelpProvider<S> helpProvider)

Sets a custom help provider for generating help messages.

Default: No default help provider system

BukkitImperat.builder(plugin)
    .helpProvider(new CustomHelpProvider())
    .build();

نکته

For detailed information on customizing help messages, see Command Help.

Usage Verification

usageVerifier(UsageVerifier<S> usageVerifier)

Sets a custom usage verifier for validating command usages.

Default: UsageVerifier.typeTolerantVerifier()

BukkitImperat.builder(plugin)
    .usageVerifier(new CustomUsageVerifier())
    .build();

Placeholders

placeholder(Placeholder<S> placeholder)

Registers a custom placeholder for dynamic content replacement, the content includes any string based input in any command-related attributes, this shall work with annotations contents.

BukkitImperat.builder(plugin)
    .placeholder(
        Placeholder.builder("%some_variable%")
        .resolver((id, cfg)-> {
            return pluginConfig.getString("some_variable");
        })
        .build();
    )
    .build();

Global Usage Builder

globalDefaultUsageBuilder(CommandUsage.Builder<S> usage)

Sets a global default usage configuration that applies to all commands registered with this Imperat instance.

Default: CommandUsage.builder() (empty builder with no defaults)

BukkitImperat.builder(plugin)
    .globalDefaultUsageBuilder(CommandUsage.builder()
        .permission("myplugin.commands")           // All commands require this permission
        .cooldown(Duration.ofSeconds(5))          // All commands have 5-second cooldown
        .description("MyPlugin command")          // Default description for all commands
        .async()                                   // All commands run asynchronously
        .usageFormat("&cUsage: /{command} {args}")) // Custom usage format
    .build();

What it does: This allows you to set default properties that will be applied to every command usage unless explicitly overridden. Useful for applying consistent permissions, cooldowns, descriptions, or other settings across your entire command system.

Example use cases:

• Setting a global permission prefix for all commands
• Applying consistent cooldowns across your plugin
• Using a custom usage format for all commands
• Setting default async execution for all commands

Return Value Handling

returnResolver(Type type, ReturnResolver<S, T> resolver)

Registers a custom return resolver for handling non-void return values from command methods.

What it does: When command methods return values instead of void, Imperat uses return resolvers to process and handle those returned values appropriately.

BukkitImperat.builder(plugin)
    .returnResolver(ServerReport.class, new ServerReportReturnResolver())
    .build();

**Example command using return values:**
```java
@Command("status")
public class StatusCommand {
    
    @Usage
    @Description("Get server status")
    public String getServerStatus(BukkitSource source) {
        return "Server is running with " + Bukkit.getOnlinePlayers().size() + " players online";
    }
    
    @SubCommand("report")
    @Description("Get detailed server report")
    public ServerReport getDetailedReport(BukkitSource source) {
        return serverMonitor.generateReport();
    }
}

نکته

For comprehensive information on return resolvers, see Return Resolvers.

helpCoordinator()

This option allows you to define how the core-components of the new Help API (since v2.0.0) interact with each other to render a help, by allowing you to inject your own instance of HelpCoordinator You can create a help coordinator instance by calling HelpCoordinator#create Here's a quick example:

BukkitImperat.builder(plugin)
    .helpCoordinator(
        HelpCoordinator.create((layoutManager)-> {
            layoutManager.registerPipeline(..., ..., ...);
        })
    )
    .build();

Advanced Configuration

applyOnConfig(Consumer<ImperatConfig<S>> configConsumer)

Applies a consumer function directly to the configuration object for advanced customization.

BukkitImperat.builder(plugin)
    .applyOnConfig(config -> {
        // Direct access to configuration object
        config.setSomeAdvancedOption(true);
    })
    .build();

Complete Example

Here's a comprehensive example showing multiple configuration options:

BukkitImperat imperat = BukkitImperat.builder(plugin)
    // Basic settings
    .strictCommandTree(true)
    
    // Custom parameter types
    .parameterType(Arena.class, new ArenaParameterType())
    .parameterType(Kit.class, new KitParameterType())
    
    // Custom source resolver
    .sourceResolver(CustomSource.class, CustomSource::new)
    
    // Custom suggestion resolver
    .defaultSuggestionResolver(new CustomSuggestionResolver())
    .namedSuggestionResolver("players", new PlayerSuggestionResolver())
    
    // Custom help provider
    .helpProvider(new CustomHelpProvider())
    
    // Custom permission resolver
    .permissionResolver(new CustomPermissionResolver())
    
    // Custom processors
    .preProcessor(new CustomPreProcessor())
    .postProcessor(new CustomPostProcessor())
    
    // Custom exception handler
    .throwableResolver(CustomException.class, (imperat, exception, context) -> {
        context.source().reply("Custom error: " + exception.getMessage());
    })
    
    // Dependency injection
    .dependencyResolver(PluginManager.class, () -> plugin.getServer().getPluginManager())
    
    // Global usage settings
    .globalDefaultUsageBuilder(CommandUsage.builder()
        .permission("myplugin.commands")
        .cooldown(Duration.ofSeconds(5)))
    
    // Return value handling
    .returnResolver(String.class, new StringReturnResolver())
    .returnResolver(ServerReport.class, new ServerReportReturnResolver())
    
    .build();

Default Configuration Summary

Option	Default Value	Description
commandPrefix	"/"	Command prefix
strictCommandTree	false	Strict command matching
permissionResolver	(source, permission) -> true	Allow all permissions
autoPermissionAssignMode	false	Auto Permission Assign mode disabled
permissionLoader	No default	Permission loading strategy for APA
permissionAssigner	NodePermissionAssigner.defaultAssigner()	Default permission assignment strategy
contextFactory	ContextFactory.defaultFactory()	Default context factory
defaultSuggestionResolver	(context, input) -> Collections.emptyList()	No suggestions
overlapOptionalParameterSuggestions	false	No overlap in suggestions
handleMiddleOptionalArgSkipping	false	Respect order of optional arguments during execution
defaultAttachmentMode	AttachmentMode.UNSET	Default attachment mode for subcommands
usageVerifier	UsageVerifier.typeTolerantVerifier()	Type-tolerant verification
helpProvider	No default system	No help provider configured
globalDefaultUsage	CommandUsage.builder()	Empty usage builder
preProcessors	Chain with permission and cooldown	Default pre-processing
postProcessors	Empty chain	No post-processing
helpCoordinator	default-coordinator	Default coordinator with default layout pipelines
returnResolver	No default resolvers	No return value handling

Configuration Order

The order of configuration methods doesn't matter - you can call them in any sequence. The builder pattern allows for flexible and readable configuration.

Platform-Specific Options

Some platforms may provide additional configuration options beyond the core Imperat configuration. Check the platform-specific documentation for more details.